# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Kirby Squeak Squad Template

game: Kirby Squeak Squad
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Kirby Squeak Squad:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  death_link:
    # When you die, everyone dies; when anyone dies, you die.
    'false': 50
    'true': 0

  goal:
    # Win condition.
    # 
    # beat_game: reach Gamble Galaxy and claim the Strawberry Shortcake (beat the game).
    # chests_and_daroach: collect a set number of chests (chest_goal_count) AND beat
    #     Daroach, the Ice Island boss (the stage-6 boss).
    beat_game: 50
    chests_and_daroach: 0

  chest_goal_count:
    # For the chests_and_daroach goal: how many chests you must collect.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 119
    70: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-119: 0 # random value between 1 and 119

  ability_checks:
    # Add a check for the first time you use each copy ability you've received.
    # 
    # Adds 23 ability-acquired locations (one per ability) and 23 more filler items
    # to match. Off = no ability-use checks.
    'false': 50
    'true': 0

  starting_spray:
    # Which spray paint Kirby owns from the start. Granted directly -- no location check is
    # consumed for it.
    # 
    # Pink is Kirby's default and is always available. Choose a color to also OWN that spray from
    # the start (it shows in your collection and you can apply / re-apply it freely from the spray
    # menu). 'none' = Pink only. Set this to 'random' in your YAML to have Archipelago pick one for
    # you -- that's handled by AP itself, so there's no explicit 'random' option here.
    # 
    # Unlike the old Random Starting Color, this grants the real spray instead of a cosmetic tint,
    # so it sticks and doesn't fight the spray menu.
    none: 50
    yellow: 0
    red: 0
    green: 0
    snow: 0
    carbon: 0
    ocean: 0
    sapphire: 0
    grape: 0
    emerald: 0
    orange: 0
    chocolate: 0
    cherry: 0
    chalk: 0
    shadow: 0
    ivory: 0
    citrus: 0
    white: 0
    lavender: 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
